package com.egg.common.swagger.param;

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * swagger 参数标准类 - yml文件字段一一对应
 * swagger 特定参数都通过继承该类实现
 *
 * @author east
 */
@Data
public abstract class SwaggerParam {


    @ApiModelProperty(value = "是否必填", notes = "true")
    private Boolean required;

    @ApiModelProperty(value = "参数名称", notes = "token")
    private String name;

    @ApiModelProperty(value = "参数值类型", notes = "string")
    private String modelRef;

    @ApiModelProperty(value = "参数类型", notes = "header")
    private String parameterType;

    @ApiModelProperty(value = "默认值", notes = "xxx")
    private String defaultValue;

    @ApiModelProperty(value = "描述", notes = "这是一个什么参数")
    private String description;

    @ApiModelProperty(value = "参数坐标", notes = "0")
    private Integer parameterIndex;


}
